Document limits of gtk_aspect_frame_get_ratio()
authorEmmanuele Bassi <ebassi@gnome.org>
Tue, 12 Jan 2021 12:28:18 +0000 (12:28 +0000)
committerEmmanuele Bassi <ebassi@gnome.org>
Tue, 12 Jan 2021 12:28:18 +0000 (12:28 +0000)
The GtkAspectFrame:ratio getter will return the value set, not the
actual ratio computed in case GtkAspectFrame:obey-child is TRUE.

gtk/gtkaspectframe.c

index 23d1ea86929971a37c2f40ef3d7f784c8f4d47a6..24938519fdee782720bb2cd39ee8f5d6b9b3a4bf 100644 (file)
@@ -458,7 +458,8 @@ gtk_aspect_frame_set_ratio (GtkAspectFrame *self,
  * gtk_aspect_frame_get_ratio:
  * @self: a #GtkAspectFrame
  *
- * Returns the desired aspect ratio of the child.
+ * Returns the desired aspect ratio of the child set using
+ * gtk_aspect_frame_set_ratio().
  *
  * Returns: the desired aspect ratio
  */